-
Notifications
You must be signed in to change notification settings - Fork 9
Create roles page #323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create roles page #323
Conversation
Ethan-Arrowood
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looking good. I think the example could also be a little longer to demonstrate multi-roles too by including the other tables/resources the guide has introduced thus far.
| ## Step 2: Assign the Role | ||
|
|
||
| Now that the role exists, assign it to a user. You can do this through the [Users and Roles API](../security/users-and-roles) or via the CLI. Once assigned, the user’s permissions will reflect exactly what you declared in `roles.yaml`. | ||
|
|
||
| For example, a user with the `dog_reader` role can insert new dog records, but not delete or update them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to walk the user through these steps now. Help them create a non-super-user user and assign that user this role. Then demonstrate some requests. Show how given one role or the other (in the authentication header of the request) results in different responses (likely 200 vs 4xx)
| The structure of the roles.yaml file is: | ||
| ## Step 3: See It in Action | ||
|
|
||
| Try it out. Sign in as the user with the `dog_reader` role and attempt the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sign in? Where? The following examples use CURL requests without actually providing any authentication headers.
versioned_docs/version-4.6/developers/applications/defining-roles.md
Outdated
Show resolved
Hide resolved
Ethan-Arrowood
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! Please make the change to the role name as Kris' comment mentions and then copy this to the docs/ folder as well as 4.5 and 4.4 versions.
Ethan-Arrowood
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
This PR makes the app roles page more narrative and adds a corresponding reference page for app roles